Repository navigation
docs(llms): add 'when to use it' and recipes, link llms.txt from PyPI - #77
Merged
Merged
Conversation
Agents choosing between packages need to know what this one is for and what it is not for, and users phrase problems as tasks, not API names. llms_intro.md gains a "When to use it" section (including what it is not for) and a "Recipes" section of task-phrased one-liners, each checked against the current code. pyproject.toml gains a project URL for llms.txt so it is discoverable from the PyPI page. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
=======================================
Coverage 98.05% 98.05%
=======================================
Files 4 4
Lines 1590 1590
=======================================
Hits 1559 1559
Misses 31 31 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
docs/llms_intro.md(the hand-written part ofllms.txt): new When to use it section, including what the package is not for, and a Recipes section of task-phrased one-liners.pyproject.toml:llms.txtproject URL, so it shows on the PyPI page.Why
An agent helping with a user's problem has to choose between packages, and users describe tasks rather than API names.
llms.txtpreviously said how to use the package but not when to reach for it.Checked
Every recipe was run against the current code.
make -C docs html llmsproduces both sections inllms.txtandllms-full.txt. (The Sphinx build prints warnings that predate this change.)🤖 Generated with Claude Code